Inside Macintosh: QuickDraw GX Objects /

Chapter 5 - Ink Objects / Ink Objects Reference

Functions / Getting and Setting an Ink's Transfer Mode

GXGetShapeTransfer

You can use the GXGetShapeTransfer function to examine the transfer mode of the ink object associated with a shape.

gxTransferMode *GXGetShapeTransfer(gxShape source, 
                                    gxTransferMode *data);

source

A reference to the shape whose ink object you want the transfer mode of.

data

A pointer to a transfer mode structure. On return, the structure contains the transfer mode of the shape's ink object.

function result

The transfer mode of the ink object associated with the source shape object.

DESCRIPTION

The GXGetShapeTransfer function returns, as its function result and in the structure pointed to by the data parameter, the transfer mode of the ink object associated with the shape referenced in the source parameter.

If the shape object reference or the pointer to the transfer mode structure is nil, an error is posted, and nil is returned as the function result.

This function is equivalent to

theMode = GXGetInkTransfer(GXGetShapeInk(myShape),theMode);

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
transferMode_is_nil

SEE ALSO

Transfer modes are described in the sections "About Transfer Modes" beginning on page 5-11, and "Working With Transfer Modes" beginning on page 5-44.

To assign a transfer mode to the ink object associated with a shape, use the GXSetShapeTransfer function, described next.

To examine the transfer mode of an ink object directly, use the GXGetInkTransfer function, described on page 5-72.

The GXGetShapeInk function is described in the chapter "Shape Objects" in this book.